<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (C) 2009 The Guava Authors<a name="line.2"></a>
<span class="sourceLineNo">003</span> *<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed under the Apache License, Version 2.0 (the "License");<a name="line.4"></a>
<span class="sourceLineNo">005</span> * you may not use this file except in compliance with the License.<a name="line.5"></a>
<span class="sourceLineNo">006</span> * You may obtain a copy of the License at<a name="line.6"></a>
<span class="sourceLineNo">007</span> *<a name="line.7"></a>
<span class="sourceLineNo">008</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * Unless required by applicable law or agreed to in writing, software<a name="line.10"></a>
<span class="sourceLineNo">011</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.11"></a>
<span class="sourceLineNo">012</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.12"></a>
<span class="sourceLineNo">013</span> * See the License for the specific language governing permissions and<a name="line.13"></a>
<span class="sourceLineNo">014</span> * limitations under the License.<a name="line.14"></a>
<span class="sourceLineNo">015</span> */<a name="line.15"></a>
<span class="sourceLineNo">016</span><a name="line.16"></a>
<span class="sourceLineNo">017</span>package com.google.common.collect;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.google.common.annotations.Beta;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import com.google.common.annotations.GwtCompatible;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.NoSuchElementException;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * A descriptor for a &lt;i&gt;discrete&lt;/i&gt; {@code Comparable} domain such as all<a name="line.25"></a>
<span class="sourceLineNo">026</span> * {@link Integer} instances. A discrete domain is one that supports the three basic<a name="line.26"></a>
<span class="sourceLineNo">027</span> * operations: {@link #next}, {@link #previous} and {@link #distance}, according<a name="line.27"></a>
<span class="sourceLineNo">028</span> * to their specifications. The methods {@link #minValue} and {@link #maxValue}<a name="line.28"></a>
<span class="sourceLineNo">029</span> * should also be overridden for bounded types.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;A discrete domain always represents the &lt;i&gt;entire&lt;/i&gt; set of values of its<a name="line.31"></a>
<span class="sourceLineNo">032</span> * type; it cannot represent partial domains such as "prime integers" or<a name="line.32"></a>
<span class="sourceLineNo">033</span> * "strings of length 5."<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;See the Guava User Guide section on &lt;a href=<a name="line.35"></a>
<span class="sourceLineNo">036</span> * "http://code.google.com/p/guava-libraries/wiki/RangesExplained#Discrete_Domains"&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * {@code DiscreteDomain}&lt;/a&gt;.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @author Kevin Bourrillion<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 10.0<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @see DiscreteDomains<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>@GwtCompatible<a name="line.43"></a>
<span class="sourceLineNo">044</span>@Beta<a name="line.44"></a>
<span class="sourceLineNo">045</span>public abstract class DiscreteDomain&lt;C extends Comparable&gt; {<a name="line.45"></a>
<span class="sourceLineNo">046</span>  /** Constructor for use by subclasses. */<a name="line.46"></a>
<span class="sourceLineNo">047</span>  protected DiscreteDomain() {}<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>  /**<a name="line.49"></a>
<span class="sourceLineNo">050</span>   * Returns the unique least value of type {@code C} that is greater than<a name="line.50"></a>
<span class="sourceLineNo">051</span>   * {@code value}, or {@code null} if none exists. Inverse operation to {@link<a name="line.51"></a>
<span class="sourceLineNo">052</span>   * #previous}.<a name="line.52"></a>
<span class="sourceLineNo">053</span>   *<a name="line.53"></a>
<span class="sourceLineNo">054</span>   * @param value any value of type {@code C}<a name="line.54"></a>
<span class="sourceLineNo">055</span>   * @return the least value greater than {@code value}, or {@code null} if<a name="line.55"></a>
<span class="sourceLineNo">056</span>   *     {@code value} is {@code maxValue()}<a name="line.56"></a>
<span class="sourceLineNo">057</span>   */<a name="line.57"></a>
<span class="sourceLineNo">058</span>  public abstract C next(C value);<a name="line.58"></a>
<span class="sourceLineNo">059</span><a name="line.59"></a>
<span class="sourceLineNo">060</span>  /**<a name="line.60"></a>
<span class="sourceLineNo">061</span>   * Returns the unique greatest value of type {@code C} that is less than<a name="line.61"></a>
<span class="sourceLineNo">062</span>   * {@code value}, or {@code null} if none exists. Inverse operation to {@link<a name="line.62"></a>
<span class="sourceLineNo">063</span>   * #next}.<a name="line.63"></a>
<span class="sourceLineNo">064</span>   *<a name="line.64"></a>
<span class="sourceLineNo">065</span>   * @param value any value of type {@code C}<a name="line.65"></a>
<span class="sourceLineNo">066</span>   * @return the greatest value less than {@code value}, or {@code null} if<a name="line.66"></a>
<span class="sourceLineNo">067</span>   *     {@code value} is {@code minValue()}<a name="line.67"></a>
<span class="sourceLineNo">068</span>   */<a name="line.68"></a>
<span class="sourceLineNo">069</span>  public abstract C previous(C value);<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>  /**<a name="line.71"></a>
<span class="sourceLineNo">072</span>   * Returns a signed value indicating how many nested invocations of {@link<a name="line.72"></a>
<span class="sourceLineNo">073</span>   * #next} (if positive) or {@link #previous} (if negative) are needed to reach<a name="line.73"></a>
<span class="sourceLineNo">074</span>   * {@code end} starting from {@code start}. For example, if {@code end =<a name="line.74"></a>
<span class="sourceLineNo">075</span>   * next(next(next(start)))}, then {@code distance(start, end) == 3} and {@code<a name="line.75"></a>
<span class="sourceLineNo">076</span>   * distance(end, start) == -3}. As well, {@code distance(a, a)} is always<a name="line.76"></a>
<span class="sourceLineNo">077</span>   * zero.<a name="line.77"></a>
<span class="sourceLineNo">078</span>   *<a name="line.78"></a>
<span class="sourceLineNo">079</span>   * &lt;p&gt;Note that this function is necessarily well-defined for any discrete<a name="line.79"></a>
<span class="sourceLineNo">080</span>   * type.<a name="line.80"></a>
<span class="sourceLineNo">081</span>   *<a name="line.81"></a>
<span class="sourceLineNo">082</span>   * @return the distance as described above, or {@link Long#MIN_VALUE} or<a name="line.82"></a>
<span class="sourceLineNo">083</span>   *     {@link Long#MAX_VALUE} if the distance is too small or too large,<a name="line.83"></a>
<span class="sourceLineNo">084</span>   *     respectively.<a name="line.84"></a>
<span class="sourceLineNo">085</span>   */<a name="line.85"></a>
<span class="sourceLineNo">086</span>  public abstract long distance(C start, C end);<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span>  /**<a name="line.88"></a>
<span class="sourceLineNo">089</span>   * Returns the minimum value of type {@code C}, if it has one. The minimum<a name="line.89"></a>
<span class="sourceLineNo">090</span>   * value is the unique value for which {@link Comparable#compareTo(Object)}<a name="line.90"></a>
<span class="sourceLineNo">091</span>   * never returns a positive value for any input of type {@code C}.<a name="line.91"></a>
<span class="sourceLineNo">092</span>   *<a name="line.92"></a>
<span class="sourceLineNo">093</span>   * &lt;p&gt;The default implementation throws {@code NoSuchElementException}.<a name="line.93"></a>
<span class="sourceLineNo">094</span>   *<a name="line.94"></a>
<span class="sourceLineNo">095</span>   * @return the minimum value of type {@code C}; never null<a name="line.95"></a>
<span class="sourceLineNo">096</span>   * @throws NoSuchElementException if the type has no (practical) minimum<a name="line.96"></a>
<span class="sourceLineNo">097</span>   *     value; for example, {@link java.math.BigInteger}<a name="line.97"></a>
<span class="sourceLineNo">098</span>   */<a name="line.98"></a>
<span class="sourceLineNo">099</span>  public C minValue() {<a name="line.99"></a>
<span class="sourceLineNo">100</span>    throw new NoSuchElementException();<a name="line.100"></a>
<span class="sourceLineNo">101</span>  }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>  /**<a name="line.103"></a>
<span class="sourceLineNo">104</span>   * Returns the maximum value of type {@code C}, if it has one. The maximum<a name="line.104"></a>
<span class="sourceLineNo">105</span>   * value is the unique value for which {@link Comparable#compareTo(Object)}<a name="line.105"></a>
<span class="sourceLineNo">106</span>   * never returns a negative value for any input of type {@code C}.<a name="line.106"></a>
<span class="sourceLineNo">107</span>   *<a name="line.107"></a>
<span class="sourceLineNo">108</span>   * &lt;p&gt;The default implementation throws {@code NoSuchElementException}.<a name="line.108"></a>
<span class="sourceLineNo">109</span>   *<a name="line.109"></a>
<span class="sourceLineNo">110</span>   * @return the maximum value of type {@code C}; never null<a name="line.110"></a>
<span class="sourceLineNo">111</span>   * @throws NoSuchElementException if the type has no (practical) maximum<a name="line.111"></a>
<span class="sourceLineNo">112</span>   *     value; for example, {@link java.math.BigInteger}<a name="line.112"></a>
<span class="sourceLineNo">113</span>   */<a name="line.113"></a>
<span class="sourceLineNo">114</span>  public C maxValue() {<a name="line.114"></a>
<span class="sourceLineNo">115</span>    throw new NoSuchElementException();<a name="line.115"></a>
<span class="sourceLineNo">116</span>  }<a name="line.116"></a>
<span class="sourceLineNo">117</span>}<a name="line.117"></a>




























































</pre>
</div>
</body>
</html>
